/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2008-2011, Salzburg Research. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * - Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * - Neither the name of the KiWi Project nor the names of its contributors
 * may be used to endorse or promote products derived from this software
 * without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * Contributor(s):
 * sschaffe
 *
 * File Info:
 * User: sschaffe
 * Date: 2011/01/19
 * Time: 10:58
 *
 * Project: KiWi2, kiwi-core module
 */

package kiwi.core.api.search;

import kiwi.core.api.transaction.TransactionData;
import kiwi.core.services.search.solr.program.parser.src.ParseException;

import java.io.InputStream;
import java.io.Reader;

/**
 * The SOLR indexing service is used to index the data that is stored in the KiWi system for efficient full-text
 * search using SOLR. The SOLR system is accessed using a local webservice call to the SOLR servlet, which is
 * mounted under the /solr subdirectory of the application context. Indexing takes place at the @AfterCommit event
 * triggered by the transaction management.
 *
 * <p/>
 * User: sschaffe
 */
public interface SolrIndexingService {

	/**
	 * loads programs and languages
	 */
	public void initialize() throws ParseException;

    /**
     * Apply the updates that are contained in the transaction data to the SOLR search index that is used for
     * full-text search.
     * <p/>
     * The method is implemented as an observer of the @AfterCommit event and thus performs the indexing when
     * changes to resources, triples and namespaces in the master database have been persisted already.
     *
     * @param data
     */
    public void updateIndex(TransactionData data);


    /**
     * Rebuild the SOLR index from scratch, using the currently visible triples in the triple store.
     */
    public void rebuildIndex();

	/**
	 * parse and set program
	 * @return
	 */
	public void parse(InputStream program) throws ParseException;
	public void parse(Reader program) throws ParseException;

}
